home *** CD-ROM | disk | FTP | other *** search
/ Chip 2007 January, February, March & April / Chip-Cover-CD-2007-02.iso / Pakiet bezpieczenstwa / mini Pentoo LiveCD 2006.1 / mpentoo-2006.1.iso / livecd.squashfs / usr / lib / mozilla-firefox / include / webbrwsr / nsIWebBrowserPrint.h < prev    next >
C/C++ Source or Header  |  2006-05-08  |  16KB  |  382 lines
  1. /*
  2.  * DO NOT EDIT.  THIS FILE IS GENERATED FROM nsIWebBrowserPrint.idl
  3.  */
  4.  
  5. #ifndef __gen_nsIWebBrowserPrint_h__
  6. #define __gen_nsIWebBrowserPrint_h__
  7.  
  8.  
  9. #ifndef __gen_nsISupports_h__
  10. #include "nsISupports.h"
  11. #endif
  12.  
  13. /* For IDL files that don't want to include root IDL files. */
  14. #ifndef NS_NO_VTABLE
  15. #define NS_NO_VTABLE
  16. #endif
  17. class nsIDOMWindow; /* forward declaration */
  18.  
  19. class nsIPrintSettings; /* forward declaration */
  20.  
  21. class nsIWebProgressListener; /* forward declaration */
  22.  
  23.  
  24. /* starting interface:    nsIWebBrowserPrint */
  25. #define NS_IWEBBROWSERPRINT_IID_STR "9a7ca4b0-fbba-11d4-a869-00105a183419"
  26.  
  27. #define NS_IWEBBROWSERPRINT_IID \
  28.   {0x9a7ca4b0, 0xfbba, 0x11d4, \
  29.     { 0xa8, 0x69, 0x00, 0x10, 0x5a, 0x18, 0x34, 0x19 }}
  30.  
  31. /**
  32.  * nsIWebBrowserPrint corresponds to the main interface
  33.  * for printing an embedded Gecko web browser window/document
  34.  *
  35.  * @status FROZEN
  36.  */
  37. class NS_NO_VTABLE nsIWebBrowserPrint : public nsISupports {
  38.  public: 
  39.  
  40.   NS_DEFINE_STATIC_IID_ACCESSOR(NS_IWEBBROWSERPRINT_IID)
  41.  
  42.   /**
  43.    * PrintPreview Navigation Constants
  44.    */
  45.   enum { PRINTPREVIEW_GOTO_PAGENUM = 0 };
  46.  
  47.   enum { PRINTPREVIEW_PREV_PAGE = 1 };
  48.  
  49.   enum { PRINTPREVIEW_NEXT_PAGE = 2 };
  50.  
  51.   enum { PRINTPREVIEW_HOME = 3 };
  52.  
  53.   enum { PRINTPREVIEW_END = 4 };
  54.  
  55.   /**
  56.    * Returns a "global" PrintSettings object 
  57.    * Creates a new the first time, if one doesn't exist.
  58.    *
  59.    * Then returns the same object each time after that.
  60.    *
  61.    * Initializes the globalPrintSettings from the default printer
  62.    */
  63.   /* readonly attribute nsIPrintSettings globalPrintSettings; */
  64.   NS_IMETHOD GetGlobalPrintSettings(nsIPrintSettings * *aGlobalPrintSettings) = 0;
  65.  
  66.   /**
  67.    * Returns a pointer to the PrintSettings object that
  68.    * that was passed into either "print" or "print preview"
  69.    *
  70.    * This enables any consumers of the interface to have access
  71.    * to the "current" PrintSetting at later points in the execution
  72.    */
  73.   /* readonly attribute nsIPrintSettings currentPrintSettings; */
  74.   NS_IMETHOD GetCurrentPrintSettings(nsIPrintSettings * *aCurrentPrintSettings) = 0;
  75.  
  76.   /**
  77.    * Returns a pointer to the current child DOMWindow
  78.    * that is being print previewed. (FrameSet Frames)
  79.    *
  80.    * Returns null if parent document is not a frameset or the entire FrameSet 
  81.    * document is being print previewed
  82.    *
  83.    * This enables any consumers of the interface to have access
  84.    * to the "current" child DOMWindow at later points in the execution
  85.    */
  86.   /* readonly attribute nsIDOMWindow currentChildDOMWindow; */
  87.   NS_IMETHOD GetCurrentChildDOMWindow(nsIDOMWindow * *aCurrentChildDOMWindow) = 0;
  88.  
  89.   /**
  90.    * Returns whether it is in Print mode
  91.    */
  92.   /* readonly attribute boolean doingPrint; */
  93.   NS_IMETHOD GetDoingPrint(PRBool *aDoingPrint) = 0;
  94.  
  95.   /**
  96.    * Returns whether it is in Print Preview mode
  97.    */
  98.   /* readonly attribute boolean doingPrintPreview; */
  99.   NS_IMETHOD GetDoingPrintPreview(PRBool *aDoingPrintPreview) = 0;
  100.  
  101.   /**
  102.    * This returns whether the current document is a frameset document
  103.    */
  104.   /* readonly attribute boolean isFramesetDocument; */
  105.   NS_IMETHOD GetIsFramesetDocument(PRBool *aIsFramesetDocument) = 0;
  106.  
  107.   /**
  108.    * This returns whether the current document is a frameset document
  109.    */
  110.   /* readonly attribute boolean isFramesetFrameSelected; */
  111.   NS_IMETHOD GetIsFramesetFrameSelected(PRBool *aIsFramesetFrameSelected) = 0;
  112.  
  113.   /**
  114.    * This returns whether there is an IFrame selected
  115.    */
  116.   /* readonly attribute boolean isIFrameSelected; */
  117.   NS_IMETHOD GetIsIFrameSelected(PRBool *aIsIFrameSelected) = 0;
  118.  
  119.   /**
  120.    * This returns whether there is a "range" selection
  121.    */
  122.   /* readonly attribute boolean isRangeSelection; */
  123.   NS_IMETHOD GetIsRangeSelection(PRBool *aIsRangeSelection) = 0;
  124.  
  125.   /**
  126.    * This returns the total number of pages for the Print Preview
  127.    */
  128.   /* readonly attribute long printPreviewNumPages; */
  129.   NS_IMETHOD GetPrintPreviewNumPages(PRInt32 *aPrintPreviewNumPages) = 0;
  130.  
  131.   /**
  132.    * Print the specified DOM window
  133.    *
  134.    * @param aThePrintSettings - Printer Settings for the print job, if aThePrintSettings is null
  135.    *                            then the global PS will be used.
  136.    * @param aWPListener - is updated during the print
  137.    * @return void
  138.    */
  139.   /* void print (in nsIPrintSettings aThePrintSettings, in nsIWebProgressListener aWPListener); */
  140.   NS_IMETHOD Print(nsIPrintSettings *aThePrintSettings, nsIWebProgressListener *aWPListener) = 0;
  141.  
  142.   /**
  143.    * Print Preview the specified DOM window
  144.    *
  145.    * @param aThePrintSettings - Printer Settings for the print preview, if aThePrintSettings is null
  146.    *                            then the global PS will be used.
  147.    * @param aChildDOMWin - DOM Window of the child document to be PP (FrameSet frames)
  148.    * @param aWPListener - is updated during the printpreview
  149.    * @return void
  150.    */
  151.   /* void printPreview (in nsIPrintSettings aThePrintSettings, in nsIDOMWindow aChildDOMWin, in nsIWebProgressListener aWPListener); */
  152.   NS_IMETHOD PrintPreview(nsIPrintSettings *aThePrintSettings, nsIDOMWindow *aChildDOMWin, nsIWebProgressListener *aWPListener) = 0;
  153.  
  154.   /**
  155.    * Print Preview - Navigates within the window
  156.    *
  157.    * @param aNavType - navigation enum
  158.    * @param aPageNum - page num to navigate to when aNavType = ePrintPreviewGoToPageNum
  159.    * @return void
  160.    */
  161.   /* void printPreviewNavigate (in short aNavType, in long aPageNum); */
  162.   NS_IMETHOD PrintPreviewNavigate(PRInt16 aNavType, PRInt32 aPageNum) = 0;
  163.  
  164.   /**
  165.    * Cancels the current print 
  166.    * @return void
  167.    */
  168.   /* void cancel (); */
  169.   NS_IMETHOD Cancel(void) = 0;
  170.  
  171.   /**
  172.    * Returns an array of the names of all documents names (Title or URL)
  173.    * and sub-documents. This will return a single item if the attr "isFramesetDocument" is false
  174.    * and may return any number of items is "isFramesetDocument" is true
  175.    *
  176.    * @param  aCount - returns number of printers returned
  177.    * @param  aResult - returns array of names
  178.    * @return void
  179.    */
  180.   /* void enumerateDocumentNames (out PRUint32 aCount, [array, size_is (aCount), retval] out wstring aResult); */
  181.   NS_IMETHOD EnumerateDocumentNames(PRUint32 *aCount, PRUnichar ***aResult) = 0;
  182.  
  183.   /**
  184.    * This exists PrintPreview mode and returns browser window to galley mode
  185.    * @return void
  186.    */
  187.   /* void exitPrintPreview (); */
  188.   NS_IMETHOD ExitPrintPreview(void) = 0;
  189.  
  190. };
  191.  
  192. /* Use this macro when declaring classes that implement this interface. */
  193. #define NS_DECL_NSIWEBBROWSERPRINT \
  194.   NS_IMETHOD GetGlobalPrintSettings(nsIPrintSettings * *aGlobalPrintSettings); \
  195.   NS_IMETHOD GetCurrentPrintSettings(nsIPrintSettings * *aCurrentPrintSettings); \
  196.   NS_IMETHOD GetCurrentChildDOMWindow(nsIDOMWindow * *aCurrentChildDOMWindow); \
  197.   NS_IMETHOD GetDoingPrint(PRBool *aDoingPrint); \
  198.   NS_IMETHOD GetDoingPrintPreview(PRBool *aDoingPrintPreview); \
  199.   NS_IMETHOD GetIsFramesetDocument(PRBool *aIsFramesetDocument); \
  200.   NS_IMETHOD GetIsFramesetFrameSelected(PRBool *aIsFramesetFrameSelected); \
  201.   NS_IMETHOD GetIsIFrameSelected(PRBool *aIsIFrameSelected); \
  202.   NS_IMETHOD GetIsRangeSelection(PRBool *aIsRangeSelection); \
  203.   NS_IMETHOD GetPrintPreviewNumPages(PRInt32 *aPrintPreviewNumPages); \
  204.   NS_IMETHOD Print(nsIPrintSettings *aThePrintSettings, nsIWebProgressListener *aWPListener); \
  205.   NS_IMETHOD PrintPreview(nsIPrintSettings *aThePrintSettings, nsIDOMWindow *aChildDOMWin, nsIWebProgressListener *aWPListener); \
  206.   NS_IMETHOD PrintPreviewNavigate(PRInt16 aNavType, PRInt32 aPageNum); \
  207.   NS_IMETHOD Cancel(void); \
  208.   NS_IMETHOD EnumerateDocumentNames(PRUint32 *aCount, PRUnichar ***aResult); \
  209.   NS_IMETHOD ExitPrintPreview(void); 
  210.  
  211. /* Use this macro to declare functions that forward the behavior of this interface to another object. */
  212. #define NS_FORWARD_NSIWEBBROWSERPRINT(_to) \
  213.   NS_IMETHOD GetGlobalPrintSettings(nsIPrintSettings * *aGlobalPrintSettings) { return _to GetGlobalPrintSettings(aGlobalPrintSettings); } \
  214.   NS_IMETHOD GetCurrentPrintSettings(nsIPrintSettings * *aCurrentPrintSettings) { return _to GetCurrentPrintSettings(aCurrentPrintSettings); } \
  215.   NS_IMETHOD GetCurrentChildDOMWindow(nsIDOMWindow * *aCurrentChildDOMWindow) { return _to GetCurrentChildDOMWindow(aCurrentChildDOMWindow); } \
  216.   NS_IMETHOD GetDoingPrint(PRBool *aDoingPrint) { return _to GetDoingPrint(aDoingPrint); } \
  217.   NS_IMETHOD GetDoingPrintPreview(PRBool *aDoingPrintPreview) { return _to GetDoingPrintPreview(aDoingPrintPreview); } \
  218.   NS_IMETHOD GetIsFramesetDocument(PRBool *aIsFramesetDocument) { return _to GetIsFramesetDocument(aIsFramesetDocument); } \
  219.   NS_IMETHOD GetIsFramesetFrameSelected(PRBool *aIsFramesetFrameSelected) { return _to GetIsFramesetFrameSelected(aIsFramesetFrameSelected); } \
  220.   NS_IMETHOD GetIsIFrameSelected(PRBool *aIsIFrameSelected) { return _to GetIsIFrameSelected(aIsIFrameSelected); } \
  221.   NS_IMETHOD GetIsRangeSelection(PRBool *aIsRangeSelection) { return _to GetIsRangeSelection(aIsRangeSelection); } \
  222.   NS_IMETHOD GetPrintPreviewNumPages(PRInt32 *aPrintPreviewNumPages) { return _to GetPrintPreviewNumPages(aPrintPreviewNumPages); } \
  223.   NS_IMETHOD Print(nsIPrintSettings *aThePrintSettings, nsIWebProgressListener *aWPListener) { return _to Print(aThePrintSettings, aWPListener); } \
  224.   NS_IMETHOD PrintPreview(nsIPrintSettings *aThePrintSettings, nsIDOMWindow *aChildDOMWin, nsIWebProgressListener *aWPListener) { return _to PrintPreview(aThePrintSettings, aChildDOMWin, aWPListener); } \
  225.   NS_IMETHOD PrintPreviewNavigate(PRInt16 aNavType, PRInt32 aPageNum) { return _to PrintPreviewNavigate(aNavType, aPageNum); } \
  226.   NS_IMETHOD Cancel(void) { return _to Cancel(); } \
  227.   NS_IMETHOD EnumerateDocumentNames(PRUint32 *aCount, PRUnichar ***aResult) { return _to EnumerateDocumentNames(aCount, aResult); } \
  228.   NS_IMETHOD ExitPrintPreview(void) { return _to ExitPrintPreview(); } 
  229.  
  230. /* Use this macro to declare functions that forward the behavior of this interface to another object in a safe way. */
  231. #define NS_FORWARD_SAFE_NSIWEBBROWSERPRINT(_to) \
  232.   NS_IMETHOD GetGlobalPrintSettings(nsIPrintSettings * *aGlobalPrintSettings) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetGlobalPrintSettings(aGlobalPrintSettings); } \
  233.   NS_IMETHOD GetCurrentPrintSettings(nsIPrintSettings * *aCurrentPrintSettings) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetCurrentPrintSettings(aCurrentPrintSettings); } \
  234.   NS_IMETHOD GetCurrentChildDOMWindow(nsIDOMWindow * *aCurrentChildDOMWindow) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetCurrentChildDOMWindow(aCurrentChildDOMWindow); } \
  235.   NS_IMETHOD GetDoingPrint(PRBool *aDoingPrint) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetDoingPrint(aDoingPrint); } \
  236.   NS_IMETHOD GetDoingPrintPreview(PRBool *aDoingPrintPreview) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetDoingPrintPreview(aDoingPrintPreview); } \
  237.   NS_IMETHOD GetIsFramesetDocument(PRBool *aIsFramesetDocument) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetIsFramesetDocument(aIsFramesetDocument); } \
  238.   NS_IMETHOD GetIsFramesetFrameSelected(PRBool *aIsFramesetFrameSelected) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetIsFramesetFrameSelected(aIsFramesetFrameSelected); } \
  239.   NS_IMETHOD GetIsIFrameSelected(PRBool *aIsIFrameSelected) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetIsIFrameSelected(aIsIFrameSelected); } \
  240.   NS_IMETHOD GetIsRangeSelection(PRBool *aIsRangeSelection) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetIsRangeSelection(aIsRangeSelection); } \
  241.   NS_IMETHOD GetPrintPreviewNumPages(PRInt32 *aPrintPreviewNumPages) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetPrintPreviewNumPages(aPrintPreviewNumPages); } \
  242.   NS_IMETHOD Print(nsIPrintSettings *aThePrintSettings, nsIWebProgressListener *aWPListener) { return !_to ? NS_ERROR_NULL_POINTER : _to->Print(aThePrintSettings, aWPListener); } \
  243.   NS_IMETHOD PrintPreview(nsIPrintSettings *aThePrintSettings, nsIDOMWindow *aChildDOMWin, nsIWebProgressListener *aWPListener) { return !_to ? NS_ERROR_NULL_POINTER : _to->PrintPreview(aThePrintSettings, aChildDOMWin, aWPListener); } \
  244.   NS_IMETHOD PrintPreviewNavigate(PRInt16 aNavType, PRInt32 aPageNum) { return !_to ? NS_ERROR_NULL_POINTER : _to->PrintPreviewNavigate(aNavType, aPageNum); } \
  245.   NS_IMETHOD Cancel(void) { return !_to ? NS_ERROR_NULL_POINTER : _to->Cancel(); } \
  246.   NS_IMETHOD EnumerateDocumentNames(PRUint32 *aCount, PRUnichar ***aResult) { return !_to ? NS_ERROR_NULL_POINTER : _to->EnumerateDocumentNames(aCount, aResult); } \
  247.   NS_IMETHOD ExitPrintPreview(void) { return !_to ? NS_ERROR_NULL_POINTER : _to->ExitPrintPreview(); } 
  248.  
  249. #if 0
  250. /* Use the code below as a template for the implementation class for this interface. */
  251.  
  252. /* Header file */
  253. class nsWebBrowserPrint : public nsIWebBrowserPrint
  254. {
  255. public:
  256.   NS_DECL_ISUPPORTS
  257.   NS_DECL_NSIWEBBROWSERPRINT
  258.  
  259.   nsWebBrowserPrint();
  260.  
  261. private:
  262.   ~nsWebBrowserPrint();
  263.  
  264. protected:
  265.   /* additional members */
  266. };
  267.  
  268. /* Implementation file */
  269. NS_IMPL_ISUPPORTS1(nsWebBrowserPrint, nsIWebBrowserPrint)
  270.  
  271. nsWebBrowserPrint::nsWebBrowserPrint()
  272. {
  273.   /* member initializers and constructor code */
  274. }
  275.  
  276. nsWebBrowserPrint::~nsWebBrowserPrint()
  277. {
  278.   /* destructor code */
  279. }
  280.  
  281. /* readonly attribute nsIPrintSettings globalPrintSettings; */
  282. NS_IMETHODIMP nsWebBrowserPrint::GetGlobalPrintSettings(nsIPrintSettings * *aGlobalPrintSettings)
  283. {
  284.     return NS_ERROR_NOT_IMPLEMENTED;
  285. }
  286.  
  287. /* readonly attribute nsIPrintSettings currentPrintSettings; */
  288. NS_IMETHODIMP nsWebBrowserPrint::GetCurrentPrintSettings(nsIPrintSettings * *aCurrentPrintSettings)
  289. {
  290.     return NS_ERROR_NOT_IMPLEMENTED;
  291. }
  292.  
  293. /* readonly attribute nsIDOMWindow currentChildDOMWindow; */
  294. NS_IMETHODIMP nsWebBrowserPrint::GetCurrentChildDOMWindow(nsIDOMWindow * *aCurrentChildDOMWindow)
  295. {
  296.     return NS_ERROR_NOT_IMPLEMENTED;
  297. }
  298.  
  299. /* readonly attribute boolean doingPrint; */
  300. NS_IMETHODIMP nsWebBrowserPrint::GetDoingPrint(PRBool *aDoingPrint)
  301. {
  302.     return NS_ERROR_NOT_IMPLEMENTED;
  303. }
  304.  
  305. /* readonly attribute boolean doingPrintPreview; */
  306. NS_IMETHODIMP nsWebBrowserPrint::GetDoingPrintPreview(PRBool *aDoingPrintPreview)
  307. {
  308.     return NS_ERROR_NOT_IMPLEMENTED;
  309. }
  310.  
  311. /* readonly attribute boolean isFramesetDocument; */
  312. NS_IMETHODIMP nsWebBrowserPrint::GetIsFramesetDocument(PRBool *aIsFramesetDocument)
  313. {
  314.     return NS_ERROR_NOT_IMPLEMENTED;
  315. }
  316.  
  317. /* readonly attribute boolean isFramesetFrameSelected; */
  318. NS_IMETHODIMP nsWebBrowserPrint::GetIsFramesetFrameSelected(PRBool *aIsFramesetFrameSelected)
  319. {
  320.     return NS_ERROR_NOT_IMPLEMENTED;
  321. }
  322.  
  323. /* readonly attribute boolean isIFrameSelected; */
  324. NS_IMETHODIMP nsWebBrowserPrint::GetIsIFrameSelected(PRBool *aIsIFrameSelected)
  325. {
  326.     return NS_ERROR_NOT_IMPLEMENTED;
  327. }
  328.  
  329. /* readonly attribute boolean isRangeSelection; */
  330. NS_IMETHODIMP nsWebBrowserPrint::GetIsRangeSelection(PRBool *aIsRangeSelection)
  331. {
  332.     return NS_ERROR_NOT_IMPLEMENTED;
  333. }
  334.  
  335. /* readonly attribute long printPreviewNumPages; */
  336. NS_IMETHODIMP nsWebBrowserPrint::GetPrintPreviewNumPages(PRInt32 *aPrintPreviewNumPages)
  337. {
  338.     return NS_ERROR_NOT_IMPLEMENTED;
  339. }
  340.  
  341. /* void print (in nsIPrintSettings aThePrintSettings, in nsIWebProgressListener aWPListener); */
  342. NS_IMETHODIMP nsWebBrowserPrint::Print(nsIPrintSettings *aThePrintSettings, nsIWebProgressListener *aWPListener)
  343. {
  344.     return NS_ERROR_NOT_IMPLEMENTED;
  345. }
  346.  
  347. /* void printPreview (in nsIPrintSettings aThePrintSettings, in nsIDOMWindow aChildDOMWin, in nsIWebProgressListener aWPListener); */
  348. NS_IMETHODIMP nsWebBrowserPrint::PrintPreview(nsIPrintSettings *aThePrintSettings, nsIDOMWindow *aChildDOMWin, nsIWebProgressListener *aWPListener)
  349. {
  350.     return NS_ERROR_NOT_IMPLEMENTED;
  351. }
  352.  
  353. /* void printPreviewNavigate (in short aNavType, in long aPageNum); */
  354. NS_IMETHODIMP nsWebBrowserPrint::PrintPreviewNavigate(PRInt16 aNavType, PRInt32 aPageNum)
  355. {
  356.     return NS_ERROR_NOT_IMPLEMENTED;
  357. }
  358.  
  359. /* void cancel (); */
  360. NS_IMETHODIMP nsWebBrowserPrint::Cancel()
  361. {
  362.     return NS_ERROR_NOT_IMPLEMENTED;
  363. }
  364.  
  365. /* void enumerateDocumentNames (out PRUint32 aCount, [array, size_is (aCount), retval] out wstring aResult); */
  366. NS_IMETHODIMP nsWebBrowserPrint::EnumerateDocumentNames(PRUint32 *aCount, PRUnichar ***aResult)
  367. {
  368.     return NS_ERROR_NOT_IMPLEMENTED;
  369. }
  370.  
  371. /* void exitPrintPreview (); */
  372. NS_IMETHODIMP nsWebBrowserPrint::ExitPrintPreview()
  373. {
  374.     return NS_ERROR_NOT_IMPLEMENTED;
  375. }
  376.  
  377. /* End of implementation class template. */
  378. #endif
  379.  
  380.  
  381. #endif /* __gen_nsIWebBrowserPrint_h__ */
  382.